Edit and restructure time series docs #3461
Open
+547
−473
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 tasks
marciw
commented
Oct 13, 2025
There was a problem hiding this comment.
Note for reviewers: The OTLP page was added in #3360 (written by @felixbarny)
Slated for more improvements in #3179
There was a problem hiding this comment.
Note for reviewers: This is a new page, but the content isn't new. It used to be part of the main/overview page. We decided to split off the content because it's sort of advanced/extra.
Includes a round of techwriterly edits
|
I really like seeing advanced topics explicitly gathered together 👏 |
kilfoyle
reviewed
Oct 14, 2025
| 3. Run the reindex operation to completion. | ||
| 4. Revert the overridden index settings in the destination index template. | ||
| 5. Invoke the `rollover` api to create a new backing index that can receive new documents. | ||
| These high-level steps summarize the process of reindexing a time series data stream. Each step is detailed in later sections. |
There was a problem hiding this comment.
Suggested change
| These high-level steps summarize the process of reindexing a time series data stream. Each step is detailed in later sections. | |
| These high-level steps summarize the process of reindexing a time series data stream. Each step is detailed in a later section. |
I assume each step is detailed in a single later section, but please ignore if I've got that wrong.
kilfoyle
reviewed
Oct 14, 2025
| If you're using {{stack}}, {{ilm-init}} can help you manage a time series data stream's backing indices. {{ilm-init}} requires an index lifecycle policy. | ||
|
|
||
| While optional, we recommend using {{ilm-init}} to automate the management of your TSDS’s backing indices. {{ilm-init}} requires an index lifecycle policy. | ||
| For best results, specify a `max_age` for the `rollover` action in the policy. This nesures the [`timestamp` ranges](/manage-data/data-store/data-streams/time-bound-tsds.md) for the backing indices are consistent. For example, setting a `max_age` of `1d` for the `rollover` action ensures your backing indices consistently contain one day's worth of data. |
There was a problem hiding this comment.
Suggested change
| For best results, specify a `max_age` for the `rollover` action in the policy. This nesures the [`timestamp` ranges](/manage-data/data-store/data-streams/time-bound-tsds.md) for the backing indices are consistent. For example, setting a `max_age` of `1d` for the `rollover` action ensures your backing indices consistently contain one day's worth of data. | |
| For best results, specify a `max_age` for the `rollover` action in the policy. This ensures the [`timestamp` ranges](/manage-data/data-store/data-streams/time-bound-tsds.md) for the backing indices are consistent. For example, setting a `max_age` of `1d` for the `rollover` action ensures your backing indices consistently contain one day's worth of data. |
kilfoyle
reviewed
Oct 14, 2025
| - Set `"lifecycle": { "enabled": true }`. | ||
| - If you created an ILM policy in [step 1](#tsds-ilm-policy), reference it with `index.lifecycle.name`. | ||
| - **Other settings** (optional): Additional index settings, such as [`index.number_of_replicas`](elasticsearch://reference/elasticsearch/index-settings/index-modules.md#dynamic-index-number-of-replicas), for the data stream's backing indices. | ||
| - **Priority:** Set the priority higher than `200`, to avoid [collisions](/manage-data/data-store/templates.md#avoid-index-pattern-collisions) with built-in templates. |
There was a problem hiding this comment.
Suggested change
| - **Priority:** Set the priority higher than `200`, to avoid [collisions](/manage-data/data-store/templates.md#avoid-index-pattern-collisions) with built-in templates. | |
| - **Priority:** Set the priority higher than `200` to avoid [collisions](/manage-data/data-store/templates.md#avoid-index-pattern-collisions) with built-in templates. |
kilfoyle
reviewed
Oct 14, 2025
| In a TSDS, each {{es}} document represents an observation, or data point, in a specific time series. Although a TSDS can contain multiple time series, a document can only belong to one time series. A time series can’t span multiple data streams. | ||
| ### Time series fields | ||
|
|
||
| Compared to a regular data stream, a TSDS uses some additional fields specific to time series: dimension fields and metric fields, plus an internal `_tsid` metadata field. |
There was a problem hiding this comment.
Suggested change
| Compared to a regular data stream, a TSDS uses some additional fields specific to time series: dimension fields and metric fields, plus an internal `_tsid` metadata field. | |
| Compared to a regular data stream, a TSDS uses some additional fields specific to time series: dimension fields and metric fields, plus an internal `_tsid` metadata field. |
Comment on lines
+3
to
+6
| applies_to: | ||
| stack: preview 9.2 | ||
| deployment: | ||
| self: |
There was a problem hiding this comment.
is this accurate? the endpoint only works for self-managed deployments? I see references to elastic cloud below but I'm not sure what the relationship is between the note and the page
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
(Replaces #3222, which was an ominshambles)
This PR restructures and edits time series data stream docs as part of #1502.
❗ Notes for reviewers:
applies_tothingies could probably be better; I am committed to maintaining the thinnest of grasps onapplies_tometadataSummary of changes: